Api.EnableAutoRestart method

Allows for auto-restart to be enabled. Following a cable disconnected, if auto-restart is enabled, the EtherCAT master restarts automatically after a cable is plugged in.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsError EnableAutoRestart(
       bool Active
)

Public Function EnableAutoRestart(
       Active As Boolean
) As KsError

Parameters

Active

Type: bool

true to enable, and false to disable auto-restart. By default, it is true.

Return value

Type: KsError

A return code of a method.

Remarks

This method must be called after Create or CreateAsync and before Start.
For more information about how HotConnect, AutoRepair, and AutoRestart work, see Concepts > HotConnect, Repair, and Restart.

Usable EtherCAT states

ecatOffline

Examples

N/A